package wx.xml.stax.api.stream.events;

/**
 * This describes the interface to Characters events.
 * All text events get reported as Characters events.
 * Content, CData and whitespace are all reported as
 * Characters events.  IgnorableWhitespace, in most cases,
 * will be set to false unless an element declaration of element
 * content is present for the current element.
 *
 * @author Copyright (c) 2003 by BEA Systems. All Rights Reserved.
 * @version 1.0
 */
public interface Characters extends XMLEvent {
    /**
     * Get the character data of this event
     */
    public String getData();

    /**
     * Returns true if this set of Characters
     * is all whitespace.  Whitespace inside a document
     * is reported as CHARACTERS.  This method allows
     * checking of CHARACTERS events to see if they
     * are composed of only whitespace characters
     */
    public boolean isWhiteSpace();

    /**
     * Returns true if this is a CData section.  If this
     * event is CData its event type will be CDATA
     * <p>
     * If wx.xml.stax.api.stream.isCoalescing is set to true CDATA Sections
     * that are surrounded by non CDATA characters will be reported
     * as a single Characters event. This method will return false
     * in this case.
     */
    public boolean isCData();

    /**
     * Return true if this is ignorableWhiteSpace.  If
     * this event is ignorableWhiteSpace its event type will
     * be SPACE.
     */
    public boolean isIgnorableWhiteSpace();

}
